<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>POIFSReader (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="POIFSReader (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/POIFSReader.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>PREV CLASS</li>
<li><a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReaderEvent.html" title="class in org.apache.poi.poifs.eventfilesystem"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/poifs/eventfilesystem/POIFSReader.html" target="_top">FRAMES</a></li>
<li><a href="POIFSReader.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.poifs.eventfilesystem</p>
<h2 title="Class POIFSReader" class="title">Class POIFSReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.poifs.eventfilesystem.POIFSReader</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>POIFSReader</strong>
extends java.lang.Object</pre>
<div class="block">An event-driven reader for POIFS file systems. Users of this class
 first create an instance of it, then use the registerListener
 methods to register POIFSReaderListener instances for specific
 documents. Once all the listeners have been registered, the read()
 method is called, which results in the listeners being notified as
 their documents are read.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Marc Johnson (mjohnson at apache dot org)</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReader.html#POIFSReader()">POIFSReader</a></strong>()</code>
<div class="block">Create a POIFSReader</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReader.html#main(java.lang.String[])">main</a></strong>(java.lang.String[]&nbsp;args)</code>
<div class="block">read in files</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReader.html#read(java.io.InputStream)">read</a></strong>(java.io.InputStream&nbsp;stream)</code>
<div class="block">Read from an InputStream and process the documents we get</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReader.html#registerListener(org.apache.poi.poifs.eventfilesystem.POIFSReaderListener)">registerListener</a></strong>(<a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReaderListener.html" title="interface in org.apache.poi.poifs.eventfilesystem">POIFSReaderListener</a>&nbsp;listener)</code>
<div class="block">Register a POIFSReaderListener for all documents</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReader.html#registerListener(org.apache.poi.poifs.eventfilesystem.POIFSReaderListener, org.apache.poi.poifs.filesystem.POIFSDocumentPath, java.lang.String)">registerListener</a></strong>(<a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReaderListener.html" title="interface in org.apache.poi.poifs.eventfilesystem">POIFSReaderListener</a>&nbsp;listener,
                <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem">POIFSDocumentPath</a>&nbsp;path,
                java.lang.String&nbsp;name)</code>
<div class="block">Register a POIFSReaderListener for a document in the specified
 directory</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReader.html#registerListener(org.apache.poi.poifs.eventfilesystem.POIFSReaderListener, java.lang.String)">registerListener</a></strong>(<a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReaderListener.html" title="interface in org.apache.poi.poifs.eventfilesystem">POIFSReaderListener</a>&nbsp;listener,
                java.lang.String&nbsp;name)</code>
<div class="block">Register a POIFSReaderListener for a document in the root
 directory</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="POIFSReader()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>POIFSReader</h4>
<pre>public&nbsp;POIFSReader()</pre>
<div class="block">Create a POIFSReader</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="read(java.io.InputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public&nbsp;void&nbsp;read(java.io.InputStream&nbsp;stream)
          throws java.io.IOException</pre>
<div class="block">Read from an InputStream and process the documents we get</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the InputStream from which to read the data</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on errors reading, or on invalid data</dd></dl>
</li>
</ul>
<a name="registerListener(org.apache.poi.poifs.eventfilesystem.POIFSReaderListener)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerListener</h4>
<pre>public&nbsp;void&nbsp;registerListener(<a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReaderListener.html" title="interface in org.apache.poi.poifs.eventfilesystem">POIFSReaderListener</a>&nbsp;listener)</pre>
<div class="block">Register a POIFSReaderListener for all documents</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to be registered</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if listener is null</dd>
<dd><code>java.lang.IllegalStateException</code> - if read() has already been
                                  called</dd></dl>
</li>
</ul>
<a name="registerListener(org.apache.poi.poifs.eventfilesystem.POIFSReaderListener, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerListener</h4>
<pre>public&nbsp;void&nbsp;registerListener(<a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReaderListener.html" title="interface in org.apache.poi.poifs.eventfilesystem">POIFSReaderListener</a>&nbsp;listener,
                    java.lang.String&nbsp;name)</pre>
<div class="block">Register a POIFSReaderListener for a document in the root
 directory</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to be registered</dd><dd><code>name</code> - the document name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if listener is null or name is
                                 null or empty</dd>
<dd><code>java.lang.IllegalStateException</code> - if read() has already been
                                  called</dd></dl>
</li>
</ul>
<a name="registerListener(org.apache.poi.poifs.eventfilesystem.POIFSReaderListener, org.apache.poi.poifs.filesystem.POIFSDocumentPath, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerListener</h4>
<pre>public&nbsp;void&nbsp;registerListener(<a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReaderListener.html" title="interface in org.apache.poi.poifs.eventfilesystem">POIFSReaderListener</a>&nbsp;listener,
                    <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem">POIFSDocumentPath</a>&nbsp;path,
                    java.lang.String&nbsp;name)</pre>
<div class="block">Register a POIFSReaderListener for a document in the specified
 directory</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to be registered</dd><dd><code>path</code> - the document path; if null, the root directory is
             assumed</dd><dd><code>name</code> - the document name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if listener is null or name is
                                 null or empty</dd>
<dd><code>java.lang.IllegalStateException</code> - if read() has already been
                                  called</dd></dl>
</li>
</ul>
<a name="main(java.lang.String[])">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)
                 throws java.io.IOException</pre>
<div class="block">read in files</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - names of the files</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/POIFSReader.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>PREV CLASS</li>
<li><a href="../../../../../org/apache/poi/poifs/eventfilesystem/POIFSReaderEvent.html" title="class in org.apache.poi.poifs.eventfilesystem"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/poifs/eventfilesystem/POIFSReader.html" target="_top">FRAMES</a></li>
<li><a href="POIFSReader.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
